MV_CC_ConvertPixelType

MV_CC_ConvertPixelType

Convert pixel format.

API Definition

int MV_CC_ConvertPixelType(
  void                         *handle,
  MV_CC_PIXEL_CONVERT_PARAM    *pstCvtParam
);

Parameters

handle

[IN] Device handle, which is returned by MV_CC_CreateHandle or MV_CC_CreateHandleWithoutLog.

pstCvtParam

[IN] [OUT] Transform input and output parameter to pixel format, see the structure MV_CC_PIXEL_CONVERT_PARAM for details.

Return Value

Return MV_OK(0) on success, and return Error Code on failure.

Remarks

This API is used to convert the collected original data to required pixel format and save to specified memory. There is no calling sequence requirement, the transformation will be executed when there is image data. First call relative API to acquire the image, then call this API to convert the format.

The following sample code is for reference only.

#include "MvCameraControl.h"

void main()
{
    int nRet = -1;
    void* m_handle = NULL;

    //Enumerate all the corresponding devices of specified transport protocol in the subnet.
    unsigned int nTLayerType = MV_GIGE_DEVICE | MV_USB_DEVICE;
    MV_CC_DEVICE_INFO_LIST m_stDevList = {0};
    int nRet = MV_CC_EnumDevices(nTLayerType, &m_stDevList);
    if (MV_OK != nRet)
    {
        printf("error: EnumDevices fail [%x]\n", nRet);
        return;
    }

    int i = 0;
    if (m_stDevList.nDeviceNum == 0)
    {
        printf("no camera found!\n");
        return;
    }

    //Selected the first online device in the search result, and create device handle.
    int nDeviceIndex = 0;

    MV_CC_DEVICE_INFO m_stDevInfo = {0};
    memcpy(&m_stDevInfo, m_stDevList.pDeviceInfo[nDeviceIndex], sizeof(MV_CC_DEVICE_INFO));

    nRet = MV_CC_CreateHandle(&m_handle, &m_stDevInfo);

    if (MV_OK != nRet)
    {
        printf("error: CreateHandle fail [%x]\n", nRet);
        return;
    }

    //Connect to device
    nRet = MV_CC_OpenDevice(m_handle, nAccessMode, nSwitchoverKey);
    if (MV_OK != nRet)
    {
        printf("error: OpenDevice fail [%x]\n", nRet);
        return;
    }
    //...Other processes

    //Start image acquisition
    nRet = MV_CC_StartGrabbing(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: StartGrabbing fail [%x]\n", nRet);
        return;
    }

    //Get the size of a frame data
    MVCC_INTVALUE stIntvalue = {0};
    nRet = MV_CC_GetIntValue(m_handle, "PayloadSize", &stIntvalue);
    if (nRet != MV_OK)
    {
        printf("Get PayloadSize failed! nRet [%x]\n", nRet);
        return;
    }
    int nBufSize = stIntvalue.nCurValue + 2048; //One frame data size + reserved bytes (handled in SDK)

    unsigned int    nTestFrameSize = 0;
    unsigned char*  pFrameBuf = NULL;   
    pFrameBuf = (unsigned char*)malloc(nBufSize);

    MV_FRAME_OUT_INFO stInfo;
    memset(&stInfo, 0, sizeof(MV_FRAME_OUT_INFO));

    //The upper layer program should control the frequency of calling  this API according to the frame rate.
    //The codes is for reference only, please establish another thread to execute image acquisition and handling in actual application.
    while(1)
    {
        if (nTestFrameSize > 99) 
        {
            break;
        }
        nRet = MV_CC_GetOneFrameTimeout(m_handle, pFrameBuf, nBufSize, &stInfo, 1000);
        if (MV_OK != nRet)
        {
            Sleep(10);
        }
        else
        {
            //Transform input and output parameter to pixel format.
            MV_CC_PIXEL_CONVERT_PARAM stParam;
            memset(&stParam, 0, sizeof(MV_CC_PIXEL_CONVERT_PARAM));
                              
            //Source data
            stParam.pSrcData       = pFrameBuf;              //Original image data
            stParam.nSrcDataLen    = stInfo.nFrameLen;         //Length of original image data
            stParam.enSrcPixelType = stInfo.enPixelType;       //Pixel format of original image
            stParam.nWidth         = stInfo.nWidth;            //Image width
            stParam.nHeight        = stInfo.nHeight;           //Image height

            //Target data
            stParam.enDstPixelType = PixelType_Gvsp_Mono8;     //Pixel format type needs to be saved, it will transform to MONO8 format
            stParam.nDstBufferSize = nBufSize;             //Size of storage node
            unsigned char* pImage  = (unsigned char*)malloc(nBufSize);
            stParam.pDstBuffer     = pImage;                   //Buffer for the output data,used to save the transformed data.

            nRet = MV_CC_ConvertPixelType(m_handle, &stParam);
            if(MV_OK != nRet)
            {
                break;
            }

            //...Processing other image data
            nTestFrameSize++;
            free(pImage);
        }
    }
    free(pFrameBuf);

    //...Other processes

    //Stop image acquisition
    nRet = MV_CC_StopGrabbing(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: StopGrabbing fail [%x]\n", nRet);
        return;
    }

    //Close device, and release resource
    nRet = MV_CC_CloseDevice(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: CloseDevice fail [%x]\n", nRet);
        return;
    }

    //Destroy handle and release resource
    nRet = MV_CC_DestroyHandle(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: DestroyHandle fail [%x]\n", nRet);
        return;
    }    
}

MV_CC_ConvertPixelType

Convert pixel format.

API Definition

int MV_CC_ConvertPixelType(
  void                         *handle,
  MV_CC_PIXEL_CONVERT_PARAM    *pstCvtParam
);

Parameters

handle

[IN] Device handle, which is returned by MV_CC_CreateHandle or MV_CC_CreateHandleWithoutLog.

pstCvtParam

[IN] [OUT] Transform input and output parameter to pixel format, see the structure MV_CC_PIXEL_CONVERT_PARAM for details.

Return Value

Return MV_OK(0) on success, and return Error Code on failure.

Remarks

This API is used to convert the collected original data to required pixel format and save to specified memory. There is no calling sequence requirement, the transformation will be executed when there is image data. First call relative API to acquire the image, then call this API to convert the format.

The following sample code is for reference only.

#include "MvCameraControl.h"

void main()
{
    int nRet = -1;
    void* m_handle = NULL;

    //Enumerate all the corresponding devices of specified transport protocol in the subnet.
    unsigned int nTLayerType = MV_GIGE_DEVICE | MV_USB_DEVICE;
    MV_CC_DEVICE_INFO_LIST m_stDevList = {0};
    int nRet = MV_CC_EnumDevices(nTLayerType, &m_stDevList);
    if (MV_OK != nRet)
    {
        printf("error: EnumDevices fail [%x]\n", nRet);
        return;
    }

    int i = 0;
    if (m_stDevList.nDeviceNum == 0)
    {
        printf("no camera found!\n");
        return;
    }

    //Selected the first online device in the search result, and create device handle.
    int nDeviceIndex = 0;

    MV_CC_DEVICE_INFO m_stDevInfo = {0};
    memcpy(&m_stDevInfo, m_stDevList.pDeviceInfo[nDeviceIndex], sizeof(MV_CC_DEVICE_INFO));

    nRet = MV_CC_CreateHandle(&m_handle, &m_stDevInfo);

    if (MV_OK != nRet)
    {
        printf("error: CreateHandle fail [%x]\n", nRet);
        return;
    }

    //Connect to device
    nRet = MV_CC_OpenDevice(m_handle, nAccessMode, nSwitchoverKey);
    if (MV_OK != nRet)
    {
        printf("error: OpenDevice fail [%x]\n", nRet);
        return;
    }
    //...Other processes

    //Start image acquisition
    nRet = MV_CC_StartGrabbing(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: StartGrabbing fail [%x]\n", nRet);
        return;
    }

    //Get the size of a frame data
    MVCC_INTVALUE stIntvalue = {0};
    nRet = MV_CC_GetIntValue(m_handle, "PayloadSize", &stIntvalue);
    if (nRet != MV_OK)
    {
        printf("Get PayloadSize failed! nRet [%x]\n", nRet);
        return;
    }
    int nBufSize = stIntvalue.nCurValue + 2048; //One frame data size + reserved bytes (handled in SDK)

    unsigned int    nTestFrameSize = 0;
    unsigned char*  pFrameBuf = NULL;   
    pFrameBuf = (unsigned char*)malloc(nBufSize);

    MV_FRAME_OUT_INFO stInfo;
    memset(&stInfo, 0, sizeof(MV_FRAME_OUT_INFO));

    //The upper layer program should control the frequency of calling  this API according to the frame rate.
    //The codes is for reference only, please establish another thread to execute image acquisition and handling in actual application.
    while(1)
    {
        if (nTestFrameSize > 99) 
        {
            break;
        }
        nRet = MV_CC_GetOneFrameTimeout(m_handle, pFrameBuf, nBufSize, &stInfo, 1000);
        if (MV_OK != nRet)
        {
            Sleep(10);
        }
        else
        {
            //Transform input and output parameter to pixel format.
            MV_CC_PIXEL_CONVERT_PARAM stParam;
            memset(&stParam, 0, sizeof(MV_CC_PIXEL_CONVERT_PARAM));
                              
            //Source data
            stParam.pSrcData       = pFrameBuf;              //Original image data
            stParam.nSrcDataLen    = stInfo.nFrameLen;         //Length of original image data
            stParam.enSrcPixelType = stInfo.enPixelType;       //Pixel format of original image
            stParam.nWidth         = stInfo.nWidth;            //Image width
            stParam.nHeight        = stInfo.nHeight;           //Image height

            //Target data
            stParam.enDstPixelType = PixelType_Gvsp_Mono8;     //Pixel format type needs to be saved, it will transform to MONO8 format
            stParam.nDstBufferSize = nBufSize;             //Size of storage node
            unsigned char* pImage  = (unsigned char*)malloc(nBufSize);
            stParam.pDstBuffer     = pImage;                   //Buffer for the output data,used to save the transformed data.

            nRet = MV_CC_ConvertPixelType(m_handle, &stParam);
            if(MV_OK != nRet)
            {
                break;
            }

            //...Processing other image data
            nTestFrameSize++;
            free(pImage);
        }
    }
    free(pFrameBuf);

    //...Other processes

    //Stop image acquisition
    nRet = MV_CC_StopGrabbing(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: StopGrabbing fail [%x]\n", nRet);
        return;
    }

    //Close device, and release resource
    nRet = MV_CC_CloseDevice(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: CloseDevice fail [%x]\n", nRet);
        return;
    }

    //Destroy handle and release resource
    nRet = MV_CC_DestroyHandle(m_handle);
    if (MV_OK != nRet)
    {
        printf("error: DestroyHandle fail [%x]\n", nRet);
        return;
    }    
}